Adding HLS plugins for linear functions and cliffords #9399
Conversation
|
Thank you for opening a new pull request. Before your PR can be merged it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient. While you're waiting, please feel free to review other open PRs. While only a subset of people are authorized to approve pull requests for merging, everyone is encouraged to review open pull requests. Doing reviews helps reduce the burden on the core team and helps make the project's code better for everyone. One or more of the the following people are requested to review this:
|
Pull Request Test Coverage Report for Build 4616968912
💛 - Coveralls |
mtreinish
added
the
Changelog: New Feature
alexanderivrii
changed the title
There was a problem hiding this comment.
Overall this LGTM, it's simple and straightforward. The only thing missing is some documentation about how to use the new plugins. None of the docstrings and the release note doesn't actually map the method to the plugin name. I think it'd be good to document this so users know how to use these plugins.
| Added high-level-synthesis plugins for :class:`.LinearFunction` and for | ||
| :class:`qiskit.quantum_info.Clifford`, extending the set of synthesis | ||
| methods that can be called from :class:`~qiskit.transpiler.passes.HighLevelSynthesis` | ||
| transpiler pass. | ||
| For :class:`.LinearFunction` the newly available plugins are | ||
| :class:`.PMHSynthesisLinearFunction` and :class:`.KMSSynthesisLinearFunction`. | ||
| For :class:`qiskit.quantum_info.Clifford` the newly available plugins are | ||
| :class:`.AGSynthesisClifford`, :class:`.BMSynthesisClifford`, | ||
| :class:`.GreedySynthesisClifford` and :class:`.LayerSynthesisClifford`. | ||
| Please refer to :mod:`qiskit.synthesis` documentation for more information | ||
| about each individual method. |
There was a problem hiding this comment.
Can you add a table or something that maps the plugin names to the methods? I think that'll be good for users so they know what the plugin names are going to be. Also having an example of how to use it with transpile would go a long way too.
There was a problem hiding this comment.
Done in 0dbcf31.
| class DefaultSynthesisLinearFunction(HighLevelSynthesisPlugin): | ||
| """The default linear function synthesis plugin.""" | ||
| class AGSynthesisClifford(HighLevelSynthesisPlugin): | ||
| """Clifford synthesis plugin based on the Aaronson-Gottesman method.""" |
There was a problem hiding this comment.
It'd be good to say explicitly in the docstring here (and for the other plugin classes) that the name of this plugin is "ag" so that users know how to specify the plugin.
There was a problem hiding this comment.
Done in a91f5d2.
* Adding barebone HLS plugins for linear functions and cliffods * adding clifford.lnn method and improving docstrings * improving release notes with table and example * docstring improvements following review
* Adding barebone HLS plugins for linear functions and cliffods * adding clifford.lnn method and improving docstrings * improving release notes with table and example * docstring improvements following review
Summary
This commit adds the high-level-synthesis plugins for
LinearFunctionandClifford, extending the set of plugins that can be called viaHighLevelSynthesistranspiler pass.This does not include any actual synthesis algorithms.